מ ע " ב םילעפמו תוכרעמ רימש

Transcription

1 SMS Gateway Interface Format... 3 Simple Xml example... 3 Advance Xml example... 4 Response XML... 5 Delivery Notification... 6 Message character length... 7 C# example... 8 PHP example VB example

2 Format Client should perform Http Post request to this URL. The encoding should be UTF-8. Using Dot Net Programming: Message text must be escaped with System.Security.SecurityElement.Escape. XML must be encoded by HttpUtility.UrlEncode(xml,.Text.Encoding.UTF8) Simple Xml example <Inforu> <User> <Username>MyUsername</Username> <Password>MyPassword</Password> </User> <Content Type="sms"> <Message>This is a test SMS Message</Message> </Content> <Recipients> <PhoneNumber> ; </PhoneNumber> </Recipients> <Settings> <SenderNumber> </SenderNumber> </Settings> </Inforu> Explanation of XML structure: UserName - Username of the account that was supplied by InforUMobile Password - Password of the account. Message SMS message that need to be sent. PhoneNumber the recipients phone list. Can be multiple recipients devided by ";" SenderNumber The number that will be displayed on the recipient phone as the sender

3 Advance Xml example <Inforu> <User> <Username>MyUserName</Username> <Password>MyPassword</Password> </User> <Content Type="sms"> <Message> This is a test SMS Message </Message> <MessagePelephone> This is a test SMS Message for Pelephone</MessagePelephone> <MessageCellcom> This is a test SMS Message for Cellcom </MessageCellcom> <MessageOrange> This is a test SMS Message for Orange </MessageOrange> <MessageMirs> This is a test SMS Message for Mirs </MessageMirs> </Content> <Recipients> <PhoneNumber> ; </PhoneNumber> <GroupNumber>5</GroupNumber> </Recipients> <Settings> <SenderName>Inforu</SenderName> <SenderNumber> </SenderNumber> <CustomerMessageID>112233</CustomerMessageID> <CustomerParameter>AffId4</CustomerParameter> <MessageInterval>0</MessageInterval> <TimeToSend>12/3/ :23</TimeToSend> <DeliveryNotificationUrl> <MaxSegments>0</MaxSegments> </Settings> </Inforu> Explanation of XML structure (All the following parameters are optional): SenderName The "SenderName" field is restricted to a maximum of 11 latin characters, and supported only in CELLCOM and ORANGE networks. In PELEPHONE and MIRS networks the "SenderName" will be replaced by "SenderNumber". Using the "SenderName" field overwrites the "SenderNumber" and not allowing the recipient to use the "reply" option on his phone. If omitted SenderNumber" will be used. MessagePelephone Use this parameter to send a message to Pelephone recipients. If omitted the Message parameter will be use. MessageCellcom Use this parameter to send a message to Cellcom recipients. If omitted the Message parameter will be use. MessageOrange Use this parameter to send a message to Orange recipients. If omitted the Message parameter will be use. MessageMirs - Use this parameter to send a message to Mirs recipients. If omitted the Message parameter will be use. GroupNumber - Use this parameter in order to send message to group according to the group defined in the web site. To send to multiple group please use ";". CustomerMessageID - Message ID on the client application. When confirmation on delivery is sent back to the client, the message ID is sent also for synchronization. CustomerParameter - Parameter set by the client that can be seen later in reports. Can be used for example to mark each message with affiliate Id

4 MessageInterval - Sending messages with number of seconds interval between them The value 0 means not interval. TimeToSend the requested date and time on which the messages will be sent. Please use the following format: dd/m/yyyy hh:mm DeliveryNotificationUrl - needed in order to send confirmation on delivery to the client. The system will perform Http post to this URL with notification information. MaxSegments when sending long messages, this parameter allow the client to set the maximum number of segments per message. Value 0 mean- unlimited segments. Response XML Explanation of Response XML structure: <Result> <Status></Status > <Description></ Description> <NumberOfRecipients></ NumberOfRecipients> </Result> 1. Status: OK=1, Failed=-1, BadUserNameOrPassword=-2, UserNameNotExists=-3, PasswordNotExists=-4, RecipientsDataNotExists=-6, MessageTextNotExists=-9, IllegalXML=-11, UserQuotaExceeded=-13, ProjectQuotaExceeded=-14, CustomerQuotaExceeded=-15, WrongDateTime=-16, WrongRecipients=-18, InvalidSenderNumber=-20, InvalidSenderName=-21, UserBlocked=-22, UserAuthenticationError=-26, NetworkTypeNotSupported=-28, NotAllNetworkTypesSupported=-29, 2. Description action verbal description. 3. NumberOfRecipients - phone numbers that the message has been sent

5 Delivery Notification The client can receive confirmation on delivery on each message sent. When sending the message the client should use the CustomerMessageID and the DeliveryNotificationUrl parameters. The system perform Http Post request to this URL about any message. The parameters for the request are: PhoneNumber the number of the recipient. Network the network of the recipient Status the status of the message. o (2) Delivered. o (-2) Not delivered. o (-4) Blocked by InforuMobile. StatusDescription If not delivered, contains the reason. CustomerMessageId the client message Id. SegmentsNumber - The amount of segments in the message Delivery Notification Example URL: with parameters: PhoneNumber= &Network=052&Status=2&StatusDescription=Message delivered&customermessageid=111&segmentsnumber=2-6 -

6 Message character length Operator Hebrew English Remarks Cellcom Orange Pelephone Mirs Supports concatenation. 70/160 chars 1 message 71/ each message contain 67 chars Hebrew (154 chars English) but all the messages appears as one message on the phone. Supports concatenation. 70/160 chars 1 message 71/ each message contain 67 chars Hebrew (154 chars English) but all the messages appears as one message on the phone. Does not support concatenation. Message will be divided to 126 chars in each segment. Does not support concatenation. Message will be divided to 70 chars Hebrew (140 chars English) in each segment

7 C# example //set password, user name, message text, semder name and number string username = "UserName"; string password = "UserPassword"; string messagetext = System.Security.SecurityElement.Escape("Message text"); string sendername = "MySender"; string sendernumber = "1111"; //set phone numbers string phoneslist = " ; ; ; ; "; //set additional parameters string timetosend = "02/12/ :30"; // create XML StringBuilder sbxml = new StringBuilder(); sbxml.append("<inforu>"); sbxml.append("<user>"); sbxml.append("<username>" + username + "</Username>"); sbxml.append("<password>" + password + "</Password>"); sbxml.append("</user>"); sbxml.append("<content Type=\"sms\">"); sbxml.append("<message>" + messagetext + "</Message>"); sbxml.append("</content>"); sbxml.append("<recipients>"); sbxml.append("<phonenumber>" + phoneslist + "</PhoneNumber>"); sbxml.append("</recipients>"); sbxml.append("<settings>"); sbxml.append("<sendername>" + sendername + "</SenderName>"); sbxml.append("<sendernumber>" + sendernumber + "</SenderNumber>"); sbxml.append("<messageinterval>" + messageinterval + "</MessageInterval>"); sbxml.append("<timetosend>" + timetosend + "</TimeToSend>"); sbxml.append("</settings>"); sbxml.append("</inforu >"); string strxml = HttpUtility.UrlEncode(sbXml.ToString(), System.Text.Encoding.UTF8); string result = PostDataToURL(" "InforuXML=" + strxml); static string PostDataToURL(string szurl, string szdata) //Setup the web request string szresult = string.empty; WebRequest Request = WebRequest.Create(szUrl); Request.Timeout = 30000; Request.Method = "POST"; Request.ContentType = "application/x-www-form-urlencoded"; //Set the POST data in a buffer byte[] PostBuffer; try - 8 -

8 // replacing " " with "+" according to Http post RPC szdata = szdata.replace(" ", "+"); //Specify the length of the buffer PostBuffer = Encoding.UTF8.GetBytes(szData); Request.ContentLength = PostBuffer.Length; //Open up a request stream Stream RequestStream = Request.GetRequestStream(); //Write the POST data RequestStream.Write(PostBuffer, 0, PostBuffer.Length); //Close the stream RequestStream.Close(); //Create the Response object WebResponse Response; Response = Request.GetResponse(); //Create the reader for the response StreamReader sr = new StreamReader(Response.GetResponseStream(), Encoding.UTF8); //Read the response szresult = sr.readtoend(); //Close the reader, and response sr.close(); Response.Close(); return szresult; catch (Exception e) return szresult; - 9 -

9 PHP example function send_sms($msg, $recepients) $msg = str_replace('<', '%26lt;', $msg); // "Cleans" the message from unsafe notes $msg = str_replace('>', '%26gt;', $msg); // "Cleans" the message from unsafe notes $msg = str_replace('\"', '%26quot;', $msg); // "Cleans" the message from unsafe notes $msg = str_replace("\'", '%26apos;', $msg); // "Cleans" the message from unsafe notes $msg = str_replace("&", '%26amp;', $msg); // "Cleans" the message from unsafe notes $msg = str_replace("\r\n", '%0D%0A', $msg); // "Cleans" the message from enter $message_text = $msg; $sms_host = " api.inforu.co.il"; // Application server's URL; $sms_port = 80; // Application server's PORT; $sms_path = "/SendMessageXml.ashx"; // Application server's PATH; // EDIT THE FOLLOWING LINES $sms_user = "USERNAME"; // User Name (Provided by Inforu) ; $sms_password = "PASSWORD"; // Password (Provided by Inforu) ; $sms_sender_name = "MyCompany"; // The SMS sender's will appear only on Cellcom & Partner's phones (Optional, only English characters, 11 max. ); $sms_sender_num = "1315"; // The number that this SMS will be sent from; $message_text = str_replace (" ", "%20", $message_text); // Encodes spaces into "%20" in the URL; $query = 'InforuXML='. urlencode('<inforu><user><username>'. $sms_user.'</username><password>'. $sms_password.'</password></user><content Type="sms"><Message>'). $message_text.urlencode('</message></content><recipients><phonenumber>'. $recepients.'</phonenumber></recipients><settings>><sendername>'. $sms_sender_name.'</sendername><sendernumber>'. $sms_sender_num.'</sendernumber><customerparameter>'. $customer_parameter.'</customerparameter></settings></inforu>'); $fp = fsockopen("$sms_host", $sms_port, $errno, $errstr, 30); // Opens a socket to the Application server if (!$fp) // Verifies that the socket has been opened and sending the message; echo "$errstr ($errno)<br />\n"; else $out = "GET $sms_path?$query HTTP/1.1\r\n"; $out.= "Host: $sms_host\r\n"; $out.= "Connection: Close\r\n\r\n"; fwrite($fp, $out); while (!feof($fp)) echo fgets($fp, 128); // Echos the respond from application server (you may replace this line with an "Message has been sent" message); fclose($fp);

10 VB example Important: need to add reference to System.Web.dll 'set password, user name, message text, semder name and number Dim username As String = "UserName" Dim password As String = "UserPassword" Dim messagetext As String = System.Security.SecurityElement.Escape("Message text") Dim sendername As String = "MySender" Dim sendernumber As String = "1111" Dim messageinterval As Integer = 0 'set phone numbers Dim phoneslist As String = " ; ; ; ; " 'set additional parameters Dim timetosend As String = "02/12/ :30" ' create XML Dim sbxml As New Text.StringBuilder() sbxml.append("<inforu>") sbxml.append("<user>") sbxml.append("<username>" & username & "</Username>") sbxml.append("<password>" & password & "</Password>") sbxml.append("</user>") sbxml.append("<content Type=""sms"">") sbxml.append("<message>" & messagetext & "</Message>") sbxml.append("</content>") sbxml.append("<recipients>") sbxml.append("<phonenumber>" & phoneslist & "</PhoneNumber>") sbxml.append("</recipients>") sbxml.append("<settings>") sbxml.append("<sendername>" & sendername & "</SenderName>") sbxml.append("<sendernumber>" & sendernumber & "</SenderNumber>") sbxml.append("<messageinterval>" & messageinterval & "</MessageInterval>") sbxml.append("<timetosend>" & timetosend & "</TimeToSend>") sbxml.append("</settings>") sbxml.append("</inforu >") Dim strxml As String = System.Web.HttpUtility.UrlEncode(sbXml.ToString(), System.Text.Encoding.UTF8) Dim result As String = PostDataToURL(" "InforuXML=" & strxml) Private Function PostDataToURL(ByVal szurl As String, ByVal szdata As String) As String 'Setup the web request Dim szresult As String = String.Empty Dim Request As Net.HttpWebRequest Request = CType(System.Net.WebRequest.Create(szUrl), System.Net.HttpWebRequest) Request.Timeout = Request.Method = "POST" Request.ContentType = "application/x-www-form-urlencoded" 'Set the POST data in a buffer

11 Dim PostBuffer As Byte() Try ' replacing " " with "+" according to Http post RPC szdata = szdata.replace(" ", "+") 'Specify the length of the buffer PostBuffer = System.Text.Encoding.UTF8.GetBytes(szData) Request.ContentLength = PostBuffer.Length 'Open up a request stream Dim RequestStream As IO.Stream = Request.GetRequestStream() 'Write the POST data RequestStream.Write(PostBuffer, 0, PostBuffer.Length) 'Close the stream RequestStream.Close() 'Create the Response object Dim Response As Net.HttpWebResponse Response = CType(Request.GetResponse(), System.Net.HttpWebResponse) 'Create the reader for the response Dim sr As New IO.StreamReader(Response.GetResponseStream(), System.Text.Encoding.UTF8) 'Read the response szresult = sr.readtoend() 'Close the reader, and response sr.close() Response.Close() Return (szresult) Catch e As Exception Return (szresult) End Try End Function